map-service API

map-service supports 4 commands: Services: pos eve edp status route sensor msg cfg asset mod map sys tftp eng tag rec aprec test index

/epe/map/render    POST version Input: Output:
Description: View tags location on a map.

Example 1: View location with mac 00:00:00:00:00:01
/epe/map/render?mac=00:00:00:00:00:01

Example 2: View location with tag id 1 and crop image.
/epe/map/render?tagid=1&width=300&height=300

Example 3: View location with tag id 1 and scale image
/epe/map/render?tagid=1&width=300&height=300&scale=true

Role Required: viewer
Call Counter: Total: 0, Failed: 0

tagid (optional) - [long] tag id
locationbeaconid (optional) - [long] id of the location beacon
name (optional) - [String] tag name
mac (optional) - [String] tag's MAC address
width (optional) - [int] image's max width
height (optional) - [int] image's max height
scale (optional) - [String] when this is set to true, image is scaled, not cropped
postype (optional) - [String] values are [good;failed;both] 'good' shows the last good position of a tag. 'failed' shows the last location only if it was failed, otherwise throws an exception. 'both' shows last good and failed positions if available. Default value is good. Good position is painted in blue and failed in red.
format (optional) - [String] content type of the response. Values are png, jpg and xml. Default is png.
TAG.tagid - [long] tag id
TAG.mac - [String] tag's MAC address
TAG.posx - [int] X coordinate of the tag
TAG.posy - [int] Y coordinate of the tag
TAG.posmodelid - [long] id of the model where the tag is
TAG.posmapname - [String] name of the map where the tag is
TAG.poszonename - [String] name of the zone where the tag is
TAG.posmapid - [int] id of the map where the tag is
TAG.poszoneid - [int] id of the zone where the tag is
TAG.posquality - [int] position quality, range 0-100
TAG.posreason - [int] tag scan reason, one of the following: 1=Button, 2=Motion, 3=Periodic, 4=Calibrate, 5=After motion, 6=Button2, 7=Tamper alarm, 8=Button3, 9=Charger status, 10=Safety switch status, 11=Low battery, 12=Motion stagnant, 13=Menu selection, 14=Supplementary, 15=Location beacon, 16=Priority message ack, 17=Battery level changed, 20=Network
TAG.postimestamp - [String] position time stamp
TAG.posfailedx - [int] X coordinate for failed position of the tag
TAG.posfailedy - [int] Y coordinate for failed position of the tag
TAG.posfailedmodelid - [long] id of the model where the tag is for failed position
TAG.posfailedmapname - [String] name of the map where the tag is for failed position
TAG.posfailedzonename - [String] name of the zone where the tag is for failed position
TAG.posfailedmapid - [int] id of the map where the tag is for failed position
TAG.posfailedzoneid - [int] id of the zone where the tag is for failed position
TAG.posfailedquality - [int] position quality for failed position, range 0-100
TAG.posfailedreason - [int] tag scan reason for failed position, one of the following: 1=Button, 2=Motion, 3=Periodic, 4=Calibrate, 5=After motion, 6=Button2, 7=Tamper alarm, 8=Button3, 9=Charger status, 10=Safety switch status, 11=Low battery, 12=Motion stagnant, 13=Menu selection, 14=Supplementary, 15=Location beacon, 16=Priority message ack, 17=Battery level changed, 20=Network
TAG.posfailedtimestamp - [String] time stamp for failed position
TAG.data_b - [bin] image data
/epe/map/_clear Input: Output:
Description: SPECIAL. Resets all service specific counters.

Role Required: poweruser
Call Counter: Total: 0, Failed: 0

/epe/map/_list    POST version Input: Output:
Description: SPECIAL. Lists the available commands, their arguments, responses, required roles, call counters and optional help descriptions.

Role Required:
Call Counter: Total: 1, Failed: 0

help (optional) - [int] set to 1 to get also HTML help description of the commands. Default is 0.
COMMAND.name - [String] command name
COMMAND.arg - [String] mandatory argument
COMMAND.optarg - [String] optional argument
COMMAND.response - [String] response field
COMMAND.internal - [int] 1 for internal command
COMMAND.role - [String] required role
COMMAND.callcount - [int] number of calls
COMMAND.callcountinternal - [int] number of internal calls
COMMAND.callcountfailure - [int] number of failed calls
COMMAND.htmlhelp - [String] command description in HTML format
/epe/map/_status Input: Output:
Description: SPECIAL. Returns status information about the service.

Role Required: viewer
Call Counter: Total: 0, Failed: 0

STATUS.callcount - [int] total number of calls for the service
STATUS.callcountinternal - [int] total number of internal calls for the service
STATUS.callcountfailure - [int] total number of failed calls for the service
STATUS.commandcount - [int] number of commands in service
STATUS.* - [String] service specific status information

(The data in this page was generated from /epe/map/_list?help=1)